Node / public / reticulum / files / docs / source / index.rst

Displaying Raw • Download

Tc9d1d9*************************************

Tc9d1d9Reticulum Network Stack Documentation

Tc9d1d9*************************************

Welcome to the documentation for Reticulum. This document aims to provide you

with all the information you need to understand Reticulum, develop programs

using it, or to participate in the development of Reticulum itself.

Tc9d1d9Table of Contents

Tc9d1d9=================

Tb4b4b4.. Tff7b72toctreeTb4b4b4::

T56d364:maxdepth: 3

whatis

gettingstartedfast

examples

reference

understanding

Tc9d1d9Current Status

Tc9d1d9==============

Reticulum should currently be considered beta software. All core protocol features are implemented and functioning, but additions will probably occur as real-world use is explored. The API and wire-format can be considered relatively stable at the moment, but could change if warranted.

Tc9d1d9Caveat Emptor

Tc9d1d9=============

Reticulum is experimental software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it has not been externally security audited, and there could very well be privacy-breaking bugs. To be considered secure, Reticulum needs a very thourough security review by independt cryptographers and security researchers. If you want to help out, or help sponsor an audit, please do get in touch.

Tc9d1d9Indices and Tables

Tc9d1d9==================

T79c0ff* Te6edf3:ref:Te6edf3`genindex`

T79c0ff* Te6edf3:ref:Te6edf3`modindex`

T79c0ff* Te6edf3:ref:Te6edf3`search`